| Package | fhir.argonaut.pd |
| Type | CapabilityStatement |
| Id | Id |
| FHIR Version | R3 |
| Source | http://fhir.org/guides/argonaut/pd/https://simplifier.net/resolve?scope=fhir.argonaut.pd@1.0.0&canonical=http://fhir.org/guides/argonaut-pd/CapabilityStatement/client |
| Url | http://fhir.org/guides/argonaut-pd/CapabilityStatement/client |
| Version | 1.0.0 |
| Status | draft |
| Date | 2016-11-13T00:00:00+11:00 |
| Name | Argonaut Provider Directory Client |
| Experimental | False |
| Realm | us |
| Authority | hl7 |
| Description | This profile defines the expected capabilities of a client when conforming to the Argonaut Provider Directory Implementation Guide. |
| Kind | requirements |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
This section describes the expected capabilities of a client actor which is responsible for creating and initiating the queries for information. It is expected that this CapabilityStatement will be used in conjuction with the Argonaut Provider Directory Server CapabilityStatement. Together they describe the basic expectations for the capabilities of a conformant client application.
The Argonaut Provider Client SHALL support fetching and querying of one or more Argonaut Provider profile(s), using the supported RESTful interactions and search parameters declared in the Argonaut Provider Directory Server CapabilityStatement
The Argonaut Provider Client SHOULD Declare a CapabilityStatement identifying the list of profiles, operations, search parameter supported.
Argonaut Clent SHALL implement the security requirements documented in the US Core IG.
Summary of Argonaut Provider search criteria
Specific client search capabilities are described in detail below in each of the resource sections. When a Server returns a PractitionerRole, Location, or Organization, an Endpoint MAY be included. The client application SHALL properly process a bundle when all resources are included, and be able to retrieve the Endpoint resource when not included.
Supported Profiles: Argonaut Endpoint Profile
Search Criteria:
A Client SHALL be capable of fetching an Endpoint using:
FHIRGET [base]/Endpoint?identifier=[system]|[code]GET [base]/Endpoint?organization=[id]GET [base]/Endpoint?name=[string]Supported Profiles: Argonaut Location Profile
Search Criteria:
A client SHALL be capable of fetching a Location using:
GET [base]/Location?identifier=[system]|[code]{&_include=Location:endpoint}GET [base]/Location?name=[string]{&_include=Location:endpoint}GET [base]/Location?address=[string]{&_include=Location:endpoint}Supported Profiles: Argonaut Organization Profile
Search Criteria:
A client SHALL be capable of fetching an Organization using:
GET [base]/Organization?identifier=[system]|[code]{&_include=Organization:endpoint}GET [base]/Organization?name=[string]{&_include=Organization:endpoint}GET [base]/Organization?address=[string]{&_include=Organization:endpoint}Supported Profiles: Argonaut Practitioner Profile
Search Criteria:
A client SHALL be capable of fetching a Practitioner using:
GET [base]/Practitioner?identifier=[system]|[code]GET [base]/Practitioner?family=[string]&given=[string]GET [base]/Practitioner?name=[string]Supported Profiles: Argonaut PractitionerRole Profile
Search Criteria:
A client SHALL be capable of fetching a PractitionerRole using:
GET [base]/PractitionerRole?practitioner.identifier=[system]|[code]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}GET [base]/PractitionerRole?practitioner.family=[string]&given=[string]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}GET [base]/PractitionerRole?specialty=[system]|[code]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}{
"resourceType" : "CapabilityStatement",
"id" : "client",
"text" : {
"status" : "additional",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\n\n\t\t<ul id=\"markdown-toc\">\n\t\t <li><a href=\"#conformance-requirements-for-the-argonaut-provider-directory-client\" id=\"markdown-toc-conformance-requirements-for-the-argonaut-provider-directory-client\">Conformance requirements for the Argonaut Provider Directory Client</a> <ul>\n\t\t <li><a href=\"#behavior-1\" id=\"markdown-toc-behavior-1\">Behavior</a></li>\n\t\t <li><a href=\"#security-1\" id=\"markdown-toc-security-1\">Security</a></li>\n\t\t <li><a href=\"#resource--details-1\" id=\"markdown-toc-resource--details-1\">Resource Details:</a> <ul>\n\t\t <li><a href=\"#endpoint-1\" id=\"markdown-toc-endpoint-1\">1. Endpoint</a></li>\n\t\t <li><a href=\"#location-1\" id=\"markdown-toc-location-1\">2. Location</a></li>\n\t\t <li><a href=\"#organization-1\" id=\"markdown-toc-organization-1\">3. Organization</a></li>\n\t\t <li><a href=\"#practitioner-1\" id=\"markdown-toc-practitioner-1\">4. Practitioner</a></li>\n\t\t <li><a href=\"#practitionerrole-1\" id=\"markdown-toc-practitionerrole-1\">5. PractitionerRole</a></li>\n\t\t </ul>\n\t\t </li>\n\t\t </ul>\n\t\t </li>\n\t\t</ul>\n\n\t\t\n\n\t\t<h3 id=\"conformance-requirements-for-the-argonaut-provider-directory-client\">Conformance requirements for the Argonaut Provider Directory Client</h3>\n\n\t\t<ul>\n\t\t <li>FHIR Version: 3.0.0</li>\n\t\t <li>Supported formats: xml, json</li>\n\t\t <li>Published: 2017-04-30</li>\n\t\t <li>Published by: Argonaut</li>\n\t\t</ul>\n\n\t\t<p>This section describes the expected capabilities of a client actor which is responsible for creating and initiating the queries for information. It is expected that this CapabilityStatement will be used in conjuction with the <a href=\"http://fhir.org/guides/argonaut-pd/r3/capstatements.html#server\">Argonaut Provider Directory Server CapabilityStatement</a>. Together they describe the basic expectations for the capabilities of a conformant client application.</p>\n\n\t\t<h4 id=\"behavior-1\">Behavior</h4>\n\n\t\t<p>The Argonaut Provider Client <strong>SHALL</strong> support fetching and querying of one or more Argonaut Provider profile(s), using the supported RESTful interactions and search parameters declared in the <a href=\"http://fhir.org/guides/argonaut-pd/r3/capstatements.html#server\">Argonaut Provider Directory Server CapabilityStatement</a></p>\n\n\t\t<p>The Argonaut Provider Client <strong>SHOULD</strong> Declare a CapabilityStatement identifying the list of profiles, operations, search parameter supported.</p>\n\n\t\t<h4 id=\"security-1\">Security</h4>\n\n\t\t<p>Argonaut Clent <strong>SHALL</strong> implement the security requirements documented in the <a href=\"http://hl7.org/fhir/us/core/STU1/security.html\">US Core IG</a>.</p>\n\n\t\t<p><strong>Summary of Argonaut Provider search criteria</strong></p>\n\n\t\t<p>Specific client search capabilities are described in detail below in each of the resource sections. When a Server returns a PractitionerRole, Location, or Organization, an Endpoint <strong>MAY</strong> be included. The client application <strong>SHALL</strong> properly process a bundle when all resources are included, and be able to retrieve the Endpoint resource when not included.</p>\n\n\t\t<h4 id=\"resource--details-1\">Resource Details:</h4>\n\n\t\t<h5 id=\"endpoint-1\">1. Endpoint</h5>\n\n\t\t<p>Supported Profiles: <a href=\"http://fhir.org/guides/argonaut-pd/r3/StructureDefinition-argo-endpoint.html\">Argonaut Endpoint Profile</a></p>\n\n\t\t<p>Search Criteria:</p>\n\n\t\t<p>A Client <strong>SHALL</strong> be capable of fetching an Endpoint using:</p>\n\n\t\t<ul>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/Endpoint?identifier=[system]|[code]</code></li>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/Endpoint?organization=[id]</code></li>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/Endpoint?name=[string]</code></li>\n\t\t</ul>\n\n\t\t<h5 id=\"location-1\">2. Location</h5>\n\t\t<p>Supported Profiles: <a href=\"http://fhir.org/guides/argonaut-pd/r3/StructureDefinition-argo-location.html\">Argonaut Location Profile</a></p>\n\n\t\t<p>Search Criteria:</p>\n\n\t\t<p>A client <strong>SHALL</strong> be capable of fetching a Location using:</p>\n\n\t\t<ul>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/Location?identifier=[system]|[code]{&_include=Location:endpoint}</code></li>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/Location?name=[string]{&_include=Location:endpoint}</code></li>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/Location?address=[string]{&_include=Location:endpoint}</code></li>\n\t\t</ul>\n\n\t\t<h5 id=\"organization-1\">3. Organization</h5>\n\t\t<p>Supported Profiles: <a href=\"http://fhir.org/guides/argonaut-pd/r3/StructureDefinition-argo-organization.html\">Argonaut Organization Profile</a></p>\n\n\t\t<p>Search Criteria:</p>\n\n\t\t<p>A client <strong>SHALL</strong> be capable of fetching an Organization using:</p>\n\n\t\t<ul>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/Organization?identifier=[system]|[code]{&_include=Organization:endpoint}</code></li>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/Organization?name=[string]{&_include=Organization:endpoint}</code></li>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/Organization?address=[string]{&_include=Organization:endpoint}</code></li>\n\t\t</ul>\n\n\t\t<h5 id=\"practitioner-1\">4. Practitioner</h5>\n\t\t<p>Supported Profiles: <a href=\"http://fhir.org/guides/argonaut-pd/r3/StructureDefinition-argo-practitioner.html\">Argonaut Practitioner Profile</a></p>\n\n\t\t<p>Search Criteria:</p>\n\n\t\t<p>A client <strong>SHALL</strong> be capable of fetching a Practitioner using:</p>\n\n\t\t<ul>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/Practitioner?identifier=[system]|[code]</code></li>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/Practitioner?family=[string]&given=[string]</code></li>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/Practitioner?name=[string]</code></li>\n\t\t</ul>\n\n\t\t<h5 id=\"practitionerrole-1\">5. PractitionerRole</h5>\n\t\t<p>Supported Profiles: <a href=\"http://fhir.org/guides/argonaut-pd/r3/StructureDefinition-argo-practitionerrole.html\">Argonaut PractitionerRole Profile</a></p>\n\n\t\t<p>Search Criteria:</p>\n\n\t\t<p>A client <strong>SHALL</strong> be capable of fetching a PractitionerRole using:</p>\n\n\t\t<ul>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?practitioner.identifier=[system]|[code]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}</code></li>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?practitioner.family=[string]&given=[string]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}</code></li>\n\t\t <li><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?specialty=[system]|[code]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}</code></li>\n\t\t</ul>\n\n\t\t<p><br/></p>\n\n\n\t\t<br/>\n\n\n\t</div>"
},
"url" : "http://fhir.org/guides/argonaut-pd/CapabilityStatement/client",
"version" : "1.0.0",
"name" : "Argonaut Provider Directory Client",
"status" : "draft",
"date" : "2016-11-13T00:00:00+11:00",
"publisher" : "Argonaut Project",
"contact" : [
{
"telecom" : [
{
"system" : "other",
"value" : "http://argonautwiki.hl7.orgs/"
}
]
}
],
"description" : "This profile defines the expected capabilities of a client when conforming to the Argonaut Provider Directory Implementation Guide.",
"kind" : "requirements",
"fhirVersion" : "STU3",
"acceptUnknown" : "extensions",
"format" : [
"xml",
"json"
],
"profile" : [
{
"reference" : "http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-practitioner"
},
{
"reference" : "http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-location"
},
{
"reference" : "http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-endpoint"
},
{
"reference" : "http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-practitionerrole"
},
{
"reference" : "http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-organization"
}
],
"rest" : [
{
"mode" : "client",
"documentation" : "'''The Argonaut Provider Directory Client''' ''SHOULD'' support querying of one or more FHIR resources using appropriate Argonaut Provider Directory profile(s), RESTful serach parameters and operations defined for the profile.",
"security" : {
"description" : "Argonaut Provider Directory Clients SHALL implement applicable security requirements documented in the Argonaut Provider Directory IG."
},
"resource" : [
{
"type" : "Practitioner",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific Argonaut Provider Directory Provider by id"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/Practitioner-name",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "family",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/Practitioner-family",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "given",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/Practitioner-given",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/Practitioner-identifier",
"type" : "token"
}
]
},
{
"type" : "Organization",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific Argonaut Provider Directory Provider Organization by id"
}
],
"searchInclude" : [
"Organization:endpoint"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/Organization-name",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "address",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/Organization-address",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/Organization-identifier",
"type" : "token"
}
]
},
{
"type" : "Location",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific Argonaut Provider Directory Provider Location by id"
}
],
"searchInclude" : [
"Location:endpoint"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/Location-name",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "address",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/Location-address",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/Location-identifier",
"type" : "token"
}
]
},
{
"type" : "Endpoint",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific Argonaut Provider Directory Provider Endpoint by id"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/Endpoint-name",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "organization",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/Endpoint-organization",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/Endpoint-identifier",
"type" : "token"
}
]
},
{
"type" : "PractitionerRole",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific Argonaut Provider Directory Provider PractitionerRole by id"
}
],
"searchInclude" : [
"PractitionerRole:practitioner",
"PractitionerRole:endpoint"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "practitioner",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/PractitionerRole-practitioner",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "location",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/PractitionerRole-location",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "specialty",
"definition" : "http://hl7.org/fhir/STU3/SearchParameter/PractitionerRole-specialty",
"type" : "token"
}
]
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.